2.4 修改本地用户(支持增量修改)

基本信息

Path: /api/v2/localUser/updateUser

Method: POST

接口描述:

  1. 对于更新接口中的非必须参数,如果不传,不会对该条数据相对应参数进行修改

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 必须  

Body

  1. 对于参数password,为了保障数据传输过程中(数据从浏览器/客户端到服务端的过程)密码数据的安全,强烈建议使用RSA算法对密码字段进行加密(将pwdModel参数设置为'rsa')。加密方式参考《使用说明文档》附录。如果您不想对密码字段进行加密(不建议),可以不传pwdModel参数或者将pwdModel参数设置为'clear'。
  2. 对于更新接口中的非必须参数,如果不传,不会对该条数据相对应参数进行修改
  3. 认证策略ID,authComposeId获取方式,用“开发者工具”过滤请求 authCompose/queryAll,在控制台“业务管理”->“认证管理”->“认证策略”页面中打开您新增用户所属的用户目录,找到所属用户目录的认证策略查询接口,查看响应体数据获取对应的认证策略ID
  4. 用户策略ID,userPolicyId获取方式,用“开发者工具”过滤请求 userPolicy/queryUserPolicy,进入控制台“业务管理”->“策略管理”->“用户策略”页面,查看响应体数据获取所需策略的ID
名称 类型 是否必须 默认值 备注 其他信息
id string 与name二选一 用户ID id与name只传一个即可,都传时以id为准
name string 与id二选一 用户名 id与name只传一个即可,都传时以id为准
groupId string 非必须 所属组ID 可用组织架构的查询接口获取
status number 非必须 启用状态:0禁用,1启用
description string 非必须 描述
pwdModel string 非必须 'clear' 密码加密算法类型:'clear'明文,'rsa'非对称加密 强烈建议使用'rsa'
password string 非必须 密码 如果不修改密码则使用默认值,需要修改密码则使用新密码;如果pwdModel使用'rsa'密码模式,需要对密码进行加密
phone string 非必须 手机号码
email string 非必须 电子邮件
expiredTime string 非必须 过期时间,13位长度的Unix时间戳,'0'表示永不过期
displayName string 非必须 显示名
externalId string 非必须 外部ID
inheritGroup number 非必须 继承所属组的应用授权:0不继承,1继承
resourceIdEditWay string 非必须 'set' 应用编辑方式,'set'重置,'append'追加,'delete'删除
resourceIdList string[] 非必须 应用ID列表 resourceIdList和resourceNameList只传一个即可,都传时以resourceIdList为准
resourceNameList string[] 非必须 应用名列表 resourceIdList和resourceNameList只传一个即可,都传时以resourceIdList为准
resourceGroupIdEditWay string 非必须 'set' 应用分类编辑方式,'set'重置,'append'追加,'delete'删除
resourceGroupIdList string[] 非必须 应用分类ID列表 resourceGroupIdList和resourceGroupNameList只传一个即可,都传时以resourceGroupIdList为准
resourceGroupNameList string[] 非必须 应用分类名列表 resourceGroupIdList和resourceGroupNameList只传一个即可,都传时以resourceGroupIdList为准
roleIdEditWay string 非必须 'set' 角色编辑方式'set'重置,'append'追加,'delete'删除
roleIdList string[] 非必须 角色ID数组 roleIdList和roleNameList只传一个即可,都传时以roleIdList为准
roleNameList string[] 非必须 角色名列表 roleIdList和roleNameList只传一个即可,都传时以roleIdList为准
authComposeId string 非必须 认证策略ID authComposeId和authComposeName只传一个即可,都传时以authComposeId为准;>=2.2.5:可以传空字符串代表策略为空
<2.2.5:不支持传空字符串
authComposeName string 非必须 认证策略名称 authComposeId和authComposeName只传一个即可,都传时以authComposeId为准;>=2.2.5:可以传空字符串代表策略为空
<2.2.5:不支持传空字符串
userPolicyId string 非必须 用户策略ID userPolicyId和userPolicyName只传一个即可,都传时以userPolicyId为准;>=2.2.5:可以传空字符串代表策略为空
<2.2.5:不支持传空字符串
userPolicyName string 非必须 用户策略名称 userPolicyId和userPolicyName只传一个即可,都传时以userPolicyId为准;>=2.2.5:可以传空字符串代表策略为空
<2.2.5:不支持传空字符串

请求示例

{
    "id": "23c916f0-5583-11eb-880a-913383f106f2",
    "status": 1,
    "description": "sdsa",
    "email": "",
    "phone": "",
    "groupId": "1059f620-5583-11eb-880a-913383f106f2",
    "expiredTime": "0",
    "inheritGroup": 1,
    "roleIdList": ["3359f620-5583-11eb-880a-913383f106f2"],
    "roleIdEditWay": "append",
    "authComposeId": "fbda378b-fa23-4e8b-b4a7-cf7f979cd85b",
    "userPolicyId": "88040d85-0e58-432c-8568-4c5a8e1907ef"
}

返回数据

名称 类型 是否必须 默认值 备注 其他信息
code number 必须 错误码,非0表示错误,具体含义请参考错误码定义
data number 必须 编辑的用户数
msg string 必须 描述信息  

返回示例

{
    "code": 0,
    "data": 1,
    "msg": "请求成功"
}

错误信息

错误提示 错误码
用户状态,是否启用错误 7201
用户密码不能为空 7201
密码长度必须为6到128位 7201
该输入项目必须是手机号码格式, 如:[国际区号-]手机号,由数字组成,长度为6-20位 7201
该输入项目必须是电子邮箱格式,如:xxx@xx.com 7201
用户最多关联2000个角色 10000000
保存失败,关联的角色不存在 77200004
密码不能属于常见弱密码 10000001
密码不能包含特殊关键字%s 10000001
本地用户不存在 77200001
本地用户不存在 77200004
外部ID重复,请重新输入 10000000
密码不能包含用户名 10000000
用户名不允许被编辑 10000000
组织架构不存在 10000001
保存失败,关联的应用集不存在 77200004
部分角色数据已经删除,请重新选择 10000001
应用不存在 77200001
保存失败,关联的应用不存在或已被删除 77200004
保存失败,关联的应用分类不存在或已被删除 77200004
用户最多关联1000个应用 77200004
深信服科技 all right reserved,powered by Gitbook本文档更新于: 2024-05-18 14:38

results matching ""

    No results matching ""